AWS AppSyncで複数のミューテーションをサブスクライブする

#AWS AppSync

#AWS

大瀧隆太

2022.01.26

この記事は公開されてから1年以上経過しています。情報が古い可能性がありますので、ご注意ください。

ども、ゲストブロガーのNTT東日本大瀧です。

AWS AppSyncは様々なAWSサービスにGraphQL APIを提供するサービスで、GraphQL自体を利用するほかに更新された内容を購読するサブスクライブ機能を利用したいケースもあったりします。サブスクライブ機能のサンプルをインターネットで探してみると特定のひとつのミューテーションを購読する例しか見つからなかったため、本記事では例えばDynamoDBテーブルのデータについての複数種類の操作をざっくりまとめて購読する例を紹介します。

複数ミューテーションのサブスクライブ

サブスクライブの定義はGraphQLのスキーマのうち Subscription タイプで定義します。以下のような感じです。

type Subscription {
	onCreateUserConfig(config: ID, id: ID): UserConfig
		@aws_subscribe(mutations: ["createUserConfig"])
	onUpdateUserConfig(config: ID, id: ID): UserConfig
		@aws_subscribe(mutations: ["updateUserConfig"])
	onDeleteUserConfig(config: ID, id: ID): UserConfig
		@aws_subscribe(mutations: ["deleteUserConfig"])
}

リクエストに複数のサブスクリプションを含めるとDuplicated operationというエラーが返ってくるため、購読のリクエストで指定できるサブスクリプションは1つだけということがわかります。一方で、単一のサブスクリプション定義にはミューテーションを複数指定できるので、以下のようなサブスクリプションを定義し、それを用いてリクエストする手が使えます。

type Subscription {
          :
	onSomethingUserConfig(config: ID, id: ID): UserConfig
		@aws_subscribe(mutations: ["createUserConfig","updateUserConfig","deleteUserConfig"])
}

ドキュメントでは以下に記載があります。